sfdc-ux (CWP)
TMF677 - getUsageConsumptionDetails
/{businessId}/queryUsageConsumption
[GET]
This method is to retrieve usage and balance information.
https://nonprod.cwp.esb.cloud.lla.com/dev/sfdc-ux-cwp/sfdc-ux/v1/{businessId}/queryUsageConsumptionurl Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BS, JM) identifying the business unit. | Y |
Header
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request | N |
Query Param
| name | type | description | required |
|---|---|---|---|
| usageConsumption.logicalResource.id | string | serviceNumber | Y |
| relatedParty.id | string | accountNumber | Y |
Sample Response
[
{
"id": "",
"queryUsageConsumptionDate": "2026-09-18T15:44:17.233Z",
"relatedParty": [
{
"id": "321474960200",
"@type": "BillingAccount"
}
],
"usageConsumption": [
{
"bucketRefOrValue": [
{
"id": "MUD_1517",
"isShared": false,
"name": "PSB 8008 DP",
"usageType": "Duration",
"bucketCounter": [
{
"counterType": "used",
"valueName": "Minutes",
"consumptionPeriod": {
"endDateTime": "2025-12-27T19:08:34.000Z"
},
"value": {
"amount": "15:9",
"units": "MINS"
}
},
{
"counterType": "carried",
"valueName": "Minutes",
"consumptionPeriod": {
"endDateTime": "2025-12-27T19:08:34.000Z"
},
"value": {
"amount": "4715:21",
"units": "MINS"
}
},
{
"counterType": "allocated",
"valueName": "Minutes",
"consumptionPeriod": {
"endDateTime": "2025-12-27T19:08:34.000Z"
},
"value": {
"amount": "00:00",
"units": "MINS"
}
}
],
"remainingValue": {
"amount": "4700:12",
"units": "MINS"
},
"validFor": {
"endDateTime": "2025-12-27T19:08:34.000Z"
}
}
],
"logicalResource": [
{
"id": "66700446",
"consumptionSummary": [
{
"counterType": "CreditLimit",
"value": {
"amount": 100000
}
},
{
"counterType": "UsageLimit",
"value": {
"amount": 0.1
}
},
{
"counterType": "ExcessLimit",
"value": {
"amount": 0
}
}
]
}
]
}
]
}
]